Retrieve Monitor Details by Status

GET 
/query/objects/status

Call this API to get the details of monitors based on their status. The status parameter must be provided in the query to filter and retrieve the monitors that match the specified status.

Request

Query Parameters

status stringrequired

The status of the monitor that you want to filter by. This parameter is required to retrieve the details of monitors that match the provided status. The possible values for status are as follows: 'Up,'Down','Unreachable','Maintenance','Disable', and 'Unknown'.

Responses

200

Successful response. The request was successful and the details of the monitors matching the specified status were returned.

application/json

Schema

Schema

result object[]
Array [
id integer
object.name integer
status string
object.ip string
object.id integer
]

Example (from schema)

{
  "result": [
    {
      "id": 1722858880,
      "object.name": "core.switch",
      "status": "up",
      "object.ip": "172.16.15.15",
      "object.id": 5
    }
  ]
}

400

The request was invalid. Possible reasons could include missing required parameters or incorrect parameter values.

application/json

Schema

Schema

response-code integer
status string
message string
error.code string

Example (from schema)

{
  "response-code": 400,
  "status": "fail",
  "message": "Bad request",
  "error.code": "MD031"
}

403

Request Forbidden. The request was forbidden. The client does not have permission to access this resource.

application/json

Schema

Schema

response-code integer
message string
error.code string

Example (from schema)

{
  "response-code": 403,
  "message": "Unauthorized access: Client is not allowed to access API",
  "error.code": "MD022"
}

500

Internal server error. An internal server error occurred while processing the request.

application/json

Schema

Schema

result object[]
Array [
response-code integer
status string
message string
error.code string
error string
]

Example (from schema)

{
  "result": [
    {
      "response-code": 500,
      "status": "fail",
      "message": "Internal server exception, Possible reason: Cannot invoke \"String.length()\" because \"content\" is null",
      "error.code": "MD031",
      "error": "io.vertx.core.json.jackson.DatabindCodec.createParser(DatabindCodec.java:116)\n\tat io.vertx.core.json.jackson.DatabindCodec.fromString(DatabindCodec.java:90)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:83)\n\tat io.vertx.core.json.Json.decodeValue(Json.java:95)\n\tat"
    }
  ]
}

Loading...